<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>Graph xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/net/big_oh/datastructures/graph/Graph.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <strong class="jxr_keyword">package</strong> net.big_oh.datastructures.graph;
<a class="jxr_linenumber" name="2" href="#2">2</a>   
<a class="jxr_linenumber" name="3" href="#3">3</a>   <strong class="jxr_keyword">import</strong> java.util.Iterator;
<a class="jxr_linenumber" name="4" href="#4">4</a>   <strong class="jxr_keyword">import</strong> java.util.Set;
<a class="jxr_linenumber" name="5" href="#5">5</a>   
<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_comment">Copyright (c) 2009 Dave Wingate dba Big-Oh Software (www.big-oh.net)</em>
<a class="jxr_linenumber" name="8" href="#8">8</a>   
<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_comment">Permission is hereby granted, free of charge, to any person</em>
<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_comment">obtaining a copy of this software and associated documentation</em>
<a class="jxr_linenumber" name="11" href="#11">11</a>  <em class="jxr_comment">files (the "Software"), to deal in the Software without</em>
<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_comment">restriction, including without limitation the rights to use,</em>
<a class="jxr_linenumber" name="13" href="#13">13</a>  <em class="jxr_comment">copy, modify, merge, publish, distribute, sublicense, and/or sell</em>
<a class="jxr_linenumber" name="14" href="#14">14</a>  <em class="jxr_comment">copies of the Software, and to permit persons to whom the</em>
<a class="jxr_linenumber" name="15" href="#15">15</a>  <em class="jxr_comment">Software is furnished to do so, subject to the following</em>
<a class="jxr_linenumber" name="16" href="#16">16</a>  <em class="jxr_comment">conditions:</em>
<a class="jxr_linenumber" name="17" href="#17">17</a>  
<a class="jxr_linenumber" name="18" href="#18">18</a>  <em class="jxr_comment">The above copyright notice and this permission notice shall be</em>
<a class="jxr_linenumber" name="19" href="#19">19</a>  <em class="jxr_comment">included in all copies or substantial portions of the Software.</em>
<a class="jxr_linenumber" name="20" href="#20">20</a>  
<a class="jxr_linenumber" name="21" href="#21">21</a>  <em class="jxr_comment">THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,</em>
<a class="jxr_linenumber" name="22" href="#22">22</a>  <em class="jxr_comment">EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES</em>
<a class="jxr_linenumber" name="23" href="#23">23</a>  <em class="jxr_comment">OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND</em>
<a class="jxr_linenumber" name="24" href="#24">24</a>  <em class="jxr_comment">NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT</em>
<a class="jxr_linenumber" name="25" href="#25">25</a>  <em class="jxr_comment">HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,</em>
<a class="jxr_linenumber" name="26" href="#26">26</a>  <em class="jxr_comment">WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING</em>
<a class="jxr_linenumber" name="27" href="#27">27</a>  <em class="jxr_comment">FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR</em>
<a class="jxr_linenumber" name="28" href="#28">28</a>  <em class="jxr_comment">OTHER DEALINGS IN THE SOFTWARE.</em>
<a class="jxr_linenumber" name="29" href="#29">29</a>  <em class="jxr_comment">*/</em>
<a class="jxr_linenumber" name="30" href="#30">30</a>  
<a class="jxr_linenumber" name="31" href="#31">31</a>  <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="32" href="#32">32</a>  <em class="jxr_javadoccomment"> * Provides a base level of abstraction for graph algorithms. The underlying</em>
<a class="jxr_linenumber" name="33" href="#33">33</a>  <em class="jxr_javadoccomment"> * implementation of this class might use the JUNG framework or, alternatively,</em>
<a class="jxr_linenumber" name="34" href="#34">34</a>  <em class="jxr_javadoccomment"> * might provide a custom view of SQL data that adheres to the interface.</em>
<a class="jxr_linenumber" name="35" href="#35">35</a>  <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="36" href="#36">36</a>  <em class="jxr_javadoccomment"> * @author dwingate</em>
<a class="jxr_linenumber" name="37" href="#37">37</a>  <em class="jxr_javadoccomment"> * @version Dec 29, 2009</em>
<a class="jxr_linenumber" name="38" href="#38">38</a>  <em class="jxr_javadoccomment"> * @param &lt;V&gt;</em>
<a class="jxr_linenumber" name="39" href="#39">39</a>  <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="40" href="#40">40</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> Graph&lt;V <strong class="jxr_keyword">extends</strong> Vertex&gt;
<a class="jxr_linenumber" name="41" href="#41">41</a>  {
<a class="jxr_linenumber" name="42" href="#42">42</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment">	 * Add a vertex to the graph.</em>
<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment">	 * </em>
<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment">	 * @param v</em>
<a class="jxr_linenumber" name="46" href="#46">46</a>  <em class="jxr_javadoccomment">	 * @throws IllegalArgumentException</em>
<a class="jxr_linenumber" name="47" href="#47">47</a>  <em class="jxr_javadoccomment">	 *             Thrown if v is null.</em>
<a class="jxr_linenumber" name="48" href="#48">48</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="49" href="#49">49</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addVertex(V v) <strong class="jxr_keyword">throws</strong> IllegalArgumentException;
<a class="jxr_linenumber" name="50" href="#50">50</a>  
<a class="jxr_linenumber" name="51" href="#51">51</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_javadoccomment">	 * Connects two vertices in the graph with an edge. The implementing class</em>
<a class="jxr_linenumber" name="53" href="#53">53</a>  <em class="jxr_javadoccomment">	 * may choose to implement either a directed or undirected edge. Depending</em>
<a class="jxr_linenumber" name="54" href="#54">54</a>  <em class="jxr_javadoccomment">	 * on that implementation choice, the post conditions of this method will</em>
<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment">	 * vary.</em>
<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment">	 * </em>
<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment">	 * @param fromVertex</em>
<a class="jxr_linenumber" name="58" href="#58">58</a>  <em class="jxr_javadoccomment">	 * @param toVertex</em>
<a class="jxr_linenumber" name="59" href="#59">59</a>  <em class="jxr_javadoccomment">	 * @throws IllegalArgumentException</em>
<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment">	 *             if either {@link Vertex} argument is null.</em>
<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="62" href="#62">62</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> addEdge(V fromVertex, V toVertex) <strong class="jxr_keyword">throws</strong> IllegalArgumentException;
<a class="jxr_linenumber" name="63" href="#63">63</a>  
<a class="jxr_linenumber" name="64" href="#64">64</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="65" href="#65">65</a>  <em class="jxr_javadoccomment">	 * @return Returns the set of all vertices contained in the graph.</em>
<a class="jxr_linenumber" name="66" href="#66">66</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="67" href="#67">67</a>  	<strong class="jxr_keyword">public</strong> Set&lt;V&gt; getAllVertices();
<a class="jxr_linenumber" name="68" href="#68">68</a>  
<a class="jxr_linenumber" name="69" href="#69">69</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="70" href="#70">70</a>  <em class="jxr_javadoccomment">	 * @return Returns an iterator that traverses the set of all vertices</em>
<a class="jxr_linenumber" name="71" href="#71">71</a>  <em class="jxr_javadoccomment">	 *         contained in the graph.</em>
<a class="jxr_linenumber" name="72" href="#72">72</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="73" href="#73">73</a>  	<strong class="jxr_keyword">public</strong> Iterator&lt;V&gt; getAllVerticesIterator();
<a class="jxr_linenumber" name="74" href="#74">74</a>  
<a class="jxr_linenumber" name="75" href="#75">75</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="76" href="#76">76</a>  <em class="jxr_javadoccomment">	 * @return Returns a count of all vertices in the graph.</em>
<a class="jxr_linenumber" name="77" href="#77">77</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="78" href="#78">78</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> getVertexCount();
<a class="jxr_linenumber" name="79" href="#79">79</a>  
<a class="jxr_linenumber" name="80" href="#80">80</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="81" href="#81">81</a>  <em class="jxr_javadoccomment">	 * @param v</em>
<a class="jxr_linenumber" name="82" href="#82">82</a>  <em class="jxr_javadoccomment">	 * @return Returns the set of all neighbors to the vertex.</em>
<a class="jxr_linenumber" name="83" href="#83">83</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="84" href="#84">84</a>  	<strong class="jxr_keyword">public</strong> Set&lt;V&gt; getAllNeighbors(V v);
<a class="jxr_linenumber" name="85" href="#85">85</a>  }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

